/*
 * Copyright (c) 2012-2013 Open Source Community - <http://www.peerfact.org>
 * Copyright (c) 2011-2012 University of Paderborn - UPB
 * Copyright (c) 2005-2011 KOM - Multimedia Communications Lab
 *
 * This file is part of PeerfactSim.KOM.
 * 
 * PeerfactSim.KOM is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * any later version.
 * 
 * PeerfactSim.KOM is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with PeerfactSim.KOM.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

package org.peerfact.impl.overlay.dht.pastry.base.messages;

import org.peerfact.impl.overlay.dht.pastry.base.components.PastryContact;

/**
 * This message is sent as reply on a <code>LookupMsg</code>
 * 
 * @author Fabio Zöllner <peerfact@kom.tu-darmstadt.de>
 * 
 * @version 05/06/2011
 */
public class LookupReplyMsg extends PastryBaseMsg {

	/**
	 * 
	 */
	private static final long serialVersionUID = 2306013622165316279L;

	/**
	 * The result of the lookup in form of a contact
	 */
	private final PastryContact responsibleContact;

	/**
	 * A reference to the original lookup request
	 */
	private final LookupMsg request;

	/**
	 * Creates a new reply to a lookup with the found contact information of the
	 * node that is responsible for the target id.
	 * 
	 * @param sender
	 *            The sender of this message
	 * @param receiver
	 *            The receiver of this message
	 * @param responsibleContact
	 *            The responsible contact for the target id
	 * @param request
	 *            The original request
	 */
	public LookupReplyMsg(PastryContact sender, PastryContact receiver,
			LookupMsg request) {

		super(sender.getOverlayID(), receiver.getOverlayID());

		this.responsibleContact = sender;
		this.request = request;
	}

	/**
	 * @return The responsible contact for the target id
	 */
	public PastryContact getResponsibleContact() {
		return responsibleContact;
	}

	/**
	 * @return The original lookup request
	 */
	public LookupMsg getRequest() {
		return request;
	}

	@Override
	public String toString() {
		return this.getClass().getSimpleName() + " responsible_contact "
				+ responsibleContact + " target " + request.getTarget();
	}

	@Override
	public long getSize() {
		return super.getSize() + responsibleContact.getTransmissionSize()
				+ request.getSize();
	}
}
